Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
CAsaObjectManager Class Reference

CAsaObjectManager is the asa object storage manager class that is used to store and retrieve asa object. More...

Public Member Functions

CAsaObject getObjectByName (string)
 Returns the asa object based on name. More...
 
CAsaObject createObject (ObjectType, string)
 Creates an asa object. More...
 
void removeObjectByName (string)
 Remove the asa object based on name. More...
 
int getNatObjectCount ()
 Get Number of Nat Objects. More...
 
int getMostUse ()
 Get the number of static and dynamic nat entries have been used. More...
 
void setMostUse (int)
 Set the number of static and dynamic nat entries have been used. More...
 
int getObjectCount ()
 Get the number of asa objects. More...
 
CAsaObject getObjectAt (int)
 Get the Asa object at a specified index. More...
 
void nameifChanged (string, string)
 This function updates the asa object that has reference to interface nameIf. More...
 

Detailed Description

CAsaObjectManager is the asa object storage manager class that is used to store and retrieve asa object.

Member Function Documentation

◆ createObject()

CAsaObject CAsaObjectManager::createObject ( ObjectType  ,
string   
)

Creates an asa object.

Parameters
objName,objectname
type,asaobject type, values: eNetwork = 0, eService = 1, eGroupService = 2, eGroupServiceTcp = 3, eGroupServiceUdp = 4, eGroupServiceTcpUdp = 5, eGroupNetwork = 6, eWebvpn = 7
Returns
CAsaObject, value is the asa object that is newly created.

◆ getMostUse()

int CAsaObjectManager::getMostUse ( )

Get the number of static and dynamic nat entries have been used.

Returns
int, value is the number of static and dynamic nat entries have been used

◆ getNatObjectCount()

int CAsaObjectManager::getNatObjectCount ( )

Get Number of Nat Objects.

Returns
int, value is the number of nat objects that are stored.

◆ getObjectAt()

CAsaObject CAsaObjectManager::getObjectAt ( int  )

Get the Asa object at a specified index.

Parameters
index,indexof the asa object to get. Range is (0, getObjectCount()).
Returns
value is the Asa object at the specified index.

◆ getObjectByName()

CAsaObject CAsaObjectManager::getObjectByName ( string  )

Returns the asa object based on name.

Parameters
objName,objectname.
Returns
CAsaObject, value is the asa object based on name.

◆ getObjectCount()

int CAsaObjectManager::getObjectCount ( )

Get the number of asa objects.

Returns
int, value is the number of asa objects.

◆ nameifChanged()

void CAsaObjectManager::nameifChanged ( string  ,
string   
)

This function updates the asa object that has reference to interface nameIf.

Parameters
newName,theinterface new nameIf
oldName,theinterface old nameIf

◆ removeObjectByName()

void CAsaObjectManager::removeObjectByName ( string  )

Remove the asa object based on name.

Parameters
objName,objectname to search with.

◆ setMostUse()

void CAsaObjectManager::setMostUse ( int  )

Set the number of static and dynamic nat entries have been used.

Parameters
mostUse,thenumber of static and dynamic nat entries have been used

The documentation for this class was generated from the following file: